List credit products
API documentation
Integrations
Analytics
Billable events
Companies
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoicing entities
Organisations
Payments
Price configurations
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
List credit products
List all credits products attached to a customer.
GET
/
v1
/
customers
/
{id}
/
credits
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"product_id": "itm_3kXODDF42QXtnL",
"current_balance": 2000,
"customer_id": "cus_Typ0px2W0aiEtl",
"name": "Credit name",
"low_count_threshold": 10,
"last_refreshed_at": "2023-11-23T09:00:01.860Z",
"created_at": "2023-10-12T07:00:01.860Z",
"updated_at": "2023-10-13T10:00:01.860Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
List of Credit.
Credit product ID.
Current credit balance.
Customer ID related to the credit
Credit name
Value indicating a low threshold.
Credit last refresh date.
Credit creation date.
Credit last edition date.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"product_id": "itm_3kXODDF42QXtnL",
"current_balance": 2000,
"customer_id": "cus_Typ0px2W0aiEtl",
"name": "Credit name",
"low_count_threshold": 10,
"last_refreshed_at": "2023-11-23T09:00:01.860Z",
"created_at": "2023-10-12T07:00:01.860Z",
"updated_at": "2023-10-13T10:00:01.860Z"
}
]
}